Overview | Package | Class | Tree | Deprecated | Index | Help			Java Platform 1.1.7
PREV CLASS | NEXT CLASS	FRAMES | NO FRAMES
SUMMARY: INNER | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

Class com.sun.java.swing.text.BoxView

java.lang.Object
  |
  +--com.sun.java.swing.text.View
        |
        +--com.sun.java.swing.text.CompositeView
              |
              +--com.sun.java.swing.text.BoxView

Subclasses:

ParagraphView, TableView.TableCell, TableView.TableRow, TableView, WrappedPlainView

public class BoxView

extends CompositeView

A view of a text model that arranges its children into a box. It might be useful to represent something like a collection of lines, paragraphs, list items, chunks of text, etc. The box is somewhat like that found in TeX where there is alignment of the children, flexibility of the children is considered, etc.

Fields inherited from class com.sun.java.swing.text.View

BadBreakWeight, ExcellentBreakWeight, ForcedBreakWeight, GoodBreakWeight, X_AXIS, Y_AXIS

Constructor Summary

BoxView(Element elem, int axis)
Constructs a BoxView.

Method Summary

void	changedUpdate(DocumentEvent e, java.awt.Shape a, ViewFactory f) Gives notification from the document that attributes were changed in a location that this view is responsible for.
void	childAllocation(int index, java.awt.Rectangle alloc) Allocates a region for a child view.
float	getAlignment(int axis) Determines the desired alignment for this view along an axis.
int	getHeight() The current height of the box.
float	getPreferredSpan(int axis) Determines the preferred span for this view along an axis.
int	getResizeWeight(int axis) Determines the resizability of the view along the given axis.
View	getViewAtPoint(int x, int y, java.awt.Rectangle alloc) Fetches the child view at the given point.
int	getWidth() The current width of the box.
void	insertUpdate(DocumentEvent e, java.awt.Shape a, ViewFactory f) Gives notification that something was inserted into the document in a location that this view is responsible for.
boolean	isAfter(int x, int y, java.awt.Rectangle innerAlloc) Determines if a point falls after an allocated region.
boolean	isAllocationValid() Are the allocations for the children still valid?
boolean	isBefore(int x, int y, java.awt.Rectangle innerAlloc) Determines if a point falls before an allocated region.
void	layout(int width, int height) Performs layout of the children.
java.awt.Shape	modelToView(int pos, java.awt.Shape a) Provides a mapping from the document model coordinate space to the coordinate space of the view mapped to it.
void	paint(java.awt.Graphics g, java.awt.Shape allocation) Renders using the given rendering surface and area on that surface.
void	paintChild(java.awt.Graphics g, java.awt.Rectangle alloc, int index) Paints a child.
void	preferenceChanged(View child, boolean width, boolean height) This is called by a child to indicated its preferred span has changed.
void	removeUpdate(DocumentEvent e, java.awt.Shape a, ViewFactory f) Gives notification that something was removed from the document in a location that this view is responsible for.
void	replace(int offset, int length, View[] elems) Invalidates the layout and resizes the cache of requests/allocations.
void	setSize(float width, float height) Sets the size of the view.
int	viewToModel(float x, float y, java.awt.Shape a) Provides a mapping from the view coordinate space to the logical coordinate space of the model.

Methods inherited from class com.sun.java.swing.text.CompositeView

append, childAllocation, getBottomInset, getChildAllocation, getInsideAllocation, getLeftInset, getRightInset, getTopInset, getViewAtPoint, getViewAtPosition, getView, getViewCount, insert, isAfter, isBefore, loadChildren, modelToView, removeAll, replace, setInsets, setParagraphInsets, setParent, viewToModel

Methods inherited from class com.sun.java.swing.text.View

breakView, changedUpdate, createFragment, getAlignment, getBreakWeight, getChildAllocation, getContainer, getDocument, getElement, getEndOffset, getParent, getPreferredSpan, getResizeWeight, getStartOffset, getViewCount, getViewFactory, getView, insertUpdate, modelToView, paint, preferenceChanged, removeUpdate, setParent, setSize, viewToModel

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notifyAll, notify, toString, wait, wait, wait

Constructor Detail

BoxView

public BoxView(Element elem,
               int axis)

Constructs a BoxView.

Parameters:

elem - the element this view is responsible for

axis - either View.X_AXIS or View.Y_AXIS

Method Detail

paintChild

protected void paintChild(java.awt.Graphics g,
                          java.awt.Rectangle alloc,
                          int index)

Paints a child. By default that is all it does, but a subclass can use this to paint things relative to the child.

Parameters:

g - the graphics context

alloc - the allocated region to paint into

index - the child index, >= 0 && < getViewCount()

replace

public void replace(int offset,
                    int length,
                    View[] elems)

Invalidates the layout and resizes the cache of requests/allocations.

Parameters:

offset - the starting offset into the child views >= 0

length - the number of existing views to replace >= 0

elems - the child views to insert

Overrides:

replace in class CompositeView

preferenceChanged

public void preferenceChanged(View child,
                              boolean width,
                              boolean height)

This is called by a child to indicated its preferred span has changed. This is implemented to throw away cached layout information so that new calculations will be done the next time the children need an allocation.

Parameters:

child - the child view

width - true if the width preference should change

height - true if the height preference should change

Overrides:

preferenceChanged in class View

setSize

public void setSize(float width,
                    float height)

Sets the size of the view. If the size has changed, layout is redone. The size is the full size of the view including the inset areas.

Parameters:

width - the width >= 0

height - the height >= 0

Overrides:

setSize in class View

paint

public void paint(java.awt.Graphics g,
                  java.awt.Shape allocation)

Renders using the given rendering surface and area on that surface.

Parameters:

g - the rendering surface to use

allocation - the allocated region to render into

Overrides:

paint in class View

See Also:

paint

modelToView

public java.awt.Shape modelToView(int pos,
                         java.awt.Shape a)
                          throws BadLocationException

Provides a mapping from the document model coordinate space to the coordinate space of the view mapped to it. This makes sure the allocation is valid before letting the superclass do its thing.

Parameters:

pos - the position to convert >= 0

a - the allocated region to render into

Returns:

the bounding box of the given position

Throws:

BadLocationException - if the given position does not represent a valid location in the associated document

Overrides:

modelToView in class CompositeView

See Also:

modelToView

viewToModel

public int viewToModel(float x,
                       float y,
                       java.awt.Shape a)

Provides a mapping from the view coordinate space to the logical coordinate space of the model.

Parameters:

x - x coordinate of the view location to convert >= 0

y - y coordinate of the view location to convert >= 0

a - the allocated region to render into

Returns:

the location within the model that best represents the given point in the view >= 0

Overrides:

viewToModel in class CompositeView

See Also:

viewToModel

getAlignment

public float getAlignment(int axis)

Determines the desired alignment for this view along an axis. This is implemented to give the total alignment needed to position the children with the alignment points lined up along the axis orthoginal to the axis that is being tiled. The axis being tiled will request to be centered (i.e. 0.5f).

Parameters:

axis - may be either View.X_AXIS or View.Y_AXIS

Throws:

java.lang.IllegalArgumentException - for an invalid axis

Overrides:

getAlignment in class View

getResizeWeight

public int getResizeWeight(int axis)

Determines the resizability of the view along the given axis. A value of 0 or less is not resizable.

Parameters:

axis - may be either View.X_AXIS or View.Y_AXIS

Returns:

the resize weight

Throws:

java.lang.IllegalArgumentException - for an invalid axis

Overrides:

getResizeWeight in class View

getPreferredSpan

public float getPreferredSpan(int axis)

Determines the preferred span for this view along an axis.

Parameters:

axis - may be either View.X_AXIS or View.Y_AXIS

Throws:

java.lang.IllegalArgumentException - for an invalid axis type

Overrides:

getPreferredSpan in class View

insertUpdate

public void insertUpdate(DocumentEvent e,
                         java.awt.Shape a,
                         ViewFactory f)

Gives notification that something was inserted into the document in a location that this view is responsible for.

Parameters:

e - the change information from the associated document

a - the current allocation of the view

f - the factory to use to rebuild if the view has children

Overrides:

insertUpdate in class View

See Also:

insertUpdate

removeUpdate

public void removeUpdate(DocumentEvent e,
                         java.awt.Shape a,
                         ViewFactory f)

Gives notification that something was removed from the document in a location that this view is responsible for.

Parameters:

e - the change information from the associated document

a - the current allocation of the view

f - the factory to use to rebuild if the view has children

Overrides:

removeUpdate in class View

See Also:

removeUpdate

changedUpdate

public void changedUpdate(DocumentEvent e,
                          java.awt.Shape a,
                          ViewFactory f)

Gives notification from the document that attributes were changed in a location that this view is responsible for.

Parameters:

e - the change information from the associated document

a - the current allocation of the view

f - the factory to use to rebuild if the view has children

Overrides:

changedUpdate in class View

See Also:

changedUpdate

isAllocationValid

protected boolean isAllocationValid()

Are the allocations for the children still valid?

Returns:

true if allocations still valid

isBefore

protected boolean isBefore(int x,
                           int y,
                           java.awt.Rectangle innerAlloc)

Determines if a point falls before an allocated region.

Parameters:

x - the X coordinate >= 0

y - the Y coordinate >= 0

innerAlloc - the allocated region. This is the area inside of the insets.

Returns:

true if the point lies before the region else false

Overrides:

isBefore in class CompositeView

isAfter

protected boolean isAfter(int x,
                          int y,
                          java.awt.Rectangle innerAlloc)

Determines if a point falls after an allocated region.

Parameters:

x - the X coordinate >= 0

y - the Y coordinate >= 0

innerAlloc - the allocated region. This is the area inside of the insets.

Returns:

true if the point lies after the region else false

Overrides:

isAfter in class CompositeView

getViewAtPoint

protected View getViewAtPoint(int x,
                              int y,
                              java.awt.Rectangle alloc)

Fetches the child view at the given point.

Parameters:

x - the X coordinate >= 0

y - the Y coordinate >= 0

alloc - the parents inner allocation on entry, which should be changed to the childs allocation on exit.

Returns:

the view

Overrides:

getViewAtPoint in class CompositeView

childAllocation

protected void childAllocation(int index,
                               java.awt.Rectangle alloc)

Allocates a region for a child view.

Parameters:

index - the index of the child view to allocate, >= 0 && < getViewCount()

alloc - the allocated region

Overrides:

childAllocation in class CompositeView

layout

protected void layout(int width,
                      int height)

Performs layout of the children. The size is the area inside of the insets.

Parameters:

width - the width >= 0

height - the height >= 0

getWidth

public final int getWidth()

The current width of the box. This is the width that it was last allocated.

getHeight

public final int getHeight()

The current height of the box. This is the height that it was last allocated.